Fixed documentation of IfcSineSpiral and IfcCosineSpiral #922
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
evandroAlfieri
requested changes
Jan 8, 2025
There was a problem hiding this comment.
Nice work @Ibrahim5aad. I've suggested a couple of editorial changes
docs/schemas/resource/IfcGeometryResource/Entities/IfcCosineSpiral.md
Outdated
Show resolved
Hide resolved
docs/schemas/resource/IfcGeometryResource/Entities/IfcSineSpiral.md
Outdated
Show resolved
Hide resolved
docs/schemas/resource/IfcGeometryResource/Entities/IfcSineSpiral.md
Outdated
Show resolved
Hide resolved
…iral.md Co-authored-by: Evandro Alfieri <[email protected]>
…al.md Co-authored-by: Evandro Alfieri <[email protected]>
…al.md Co-authored-by: Evandro Alfieri <[email protected]>
evandroAlfieri
approved these changes
Jan 10, 2025
aothms
reviewed
Jan 22, 2025
| <!-- end of short definition --> | ||
| The cosine spiral curve is parameterized by its curve length and for a given parameter $s$, the heading angle $\theta(s)$ and the curvature $\kappa(s)$ are defined as follows. Here, $A_0$ corresponds to the *ConstantTerm* and $A_1$ to the *CosineTerm*. |
There was a problem hiding this comment.
Thanks for the nice latex, but currently inline math no longer works like that in mathjax https://docs.mathjax.org/en/latest/input/tex/delimiters.html
I couldn't get their suggestion to override inlineMath to work either.
Could you change your inline math to the following below? I know it doesn't read as pretty in plain text.. We need double backslash because we first do a conversion from md to html btw.
Suggested change
| The cosine spiral curve is parameterized by its curve length and for a given parameter $s$, the heading angle $\theta(s)$ and the curvature $\kappa(s)$ are defined as follows. Here, $A_0$ corresponds to the *ConstantTerm* and $A_1$ to the *CosineTerm*. | |
| The cosine spiral curve is parameterized by its curve length and for a given parameter \\(s\\), the heading angle \\(\theta(s)\\) and the curvature \\(\kappa(s)\\) are defined as follows. Here, \\(A_0\\) corresponds to the *ConstantTerm* and \\(A_1\\) to the *CosineTerm*. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Credits to @RickBrice and @evandroAlfieri